<!doctype html>

<head>
 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
 <title>Buy Local: README</title>
 <style type="text/css">
  body {
   background: #CCC;
  }
  div#container {
   margin: 50px auto;
   width: 600px;
   padding: 0px 40px 30px 40px;
   border: 1px solid #AAA;
   -moz-border-radius: 8px;
   -khtml-border-radius: 8px;
   -webkit-border-radius: 8px;
   text-align: left;
   background-color: #EEE;
  }
  h1 {
   color: #666;
   font-weight: normal;
   border-bottom: 1px solid #AAA;
  }
  h1#title {
   color: #666;
   font-size: 3em;
   font-weight: normal;
   text-align: center;
   border: none;
   margin-bottom: none;
   padding-bottom: none;
  }
  h4#version {
   color: #555;
   text-align: center;
   margin-top: none;
   padding-top: none;
  }
 </style>
</head>

<body>

<div id="container">
 <h1 id="title">BuyLocal</h1>
 <h4 id="version">Version 0.3.0</h2>
 
 <h1>Introduction</h1>
 <p>The Buy Local Open Source Rensselaer (BLOSR), created by Professor Ron Eglash (Rensselaer Polytechnic Institute) and graduate student Logan Williams (Rensselear), promotes community ties through a vision of convenient, sustainable, shopping. The project is funded by the <a href="http://rcos.cs.rpi.edu/">Renssealer Center for Open Source</a>.</p>
 
 <p>This document provides basic information on <a href="#install">installation</a> and <a href="#docs">documentation</a> of the BuyLocal software package.  Additional information and current development status may be found at the <a href="http://code.google.com/p/buylocalopensourcerensselaer/">Google Code</a> page for the BLOSR project.</p>
 
 <h1>License</h1>
 <p>BuyLocal is released under the GNU General Public License, version 3.  A copy of this license is included in the BuyLocal package (see <a href="COPYING.txt">COPYING.txt</a>) and may additionally be found at the website of the <a href="http://www.gnu.org/licenses/gpl-3.0.html">Free Software Foundation</a>.</p>
    
 <h1>System Requirements</h1>
 <p>BuyLocal requires:</p>
 <ul>
  <li>MySQL 4.1.3</li>
  <li>PHP 5</li>
  <li>The MHash library and its PHP module (php5-mhash)</li> It should also be noted that the Mhash library and the related PHP module (php5-mhash) are required.
 </ul>
 <p>A database must be created for BuyLocal.  If database creation permissions are not present for your account, contact your system administrator and request a database be created for BuyLocal.</p>
 <p>If you choose to use another database module, confirm that it exists within the <code>/src/database</code> folder before proceeding.  If your installation of PHP does not have the MHash library, refer to the <a href="http://php.net/manual/en/book.mhash.php">MHash library documentation</a> at PHP.net for assistance in installing it.</p>
 
 <h1 id="install">Installation</h1>
 <p>Installation requires the modification of the following files:</p>
 <ul>
  <li><code>/src/presets.php</code></li>
  <li><code>/www/stylesheets/main.css</code> (Optional)</li>
 </ul>
 <ol>
  <li>Create a database for BuyLocal.  The database user granted access to that database requires the following SQL permissions for installation: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, CREATE ROUTINE, and EXECUTE.  After installation, the CREATE, DROP, and CREATE ROUTINE privileges may be removed.</li>
  <li>Place the contents of the <code>/www</code> directory in a web accessible directory.  For example, if your installation is to be located at http://example.com/buylocal and that corresponds to <code>/home/myuser/buylocal</code>, place the contents of <code>/www</code> within the <code>buylocal</code> directory.</li>
  <li>Place the <code>/src</code> and <code>/log</code> directory in non web-accessible folders.  You will need to map to these folders in <code>presets.php</code> later..</li>
  <li>Open the <code>/src/presets.php</code> file and fill in the "Required Configuration Section," lines 23 to 145.</li>
  <li>Modify the <code>/log/errors.txt</code> file, or whichever file you choose as your log, to be writable by your web server and PHP.</li>
  <li>Access the <code>install.php</code> file through a web browser and follow the instructions.  For a basic installation, leave the database information blank.  For a migration and upgrade, enter the database information for the old database (from version 0.1.0).  Note that the 0.1.0 database must be a physically different database from the database you are creating.</li>
  <li>If required (i.e. images do not appear), modify the image locations on lines 348 and 352 of the <code>main.css</code> file within the <code>stylesheets</code> folder of the web-accessible directory file after install.</li>
  <li>Remove the <code>install.php</code> file from the web-accessible directory and remove the Confirmation code from the <code>/src/install_upgrade_presets.php</code> file for security.</li>
 </ol>
 
 <h1 id="docs">Documentation</h1>
 <p>Full documentation may be found in the <code>/docs</code> folder.  Additional documentation, if available, may be found at the <a href="http://code.google.com/p/buylocalopensourcerensselaer/">Google Code</a> page for the BLOSR project.</p>
</div>

</body>

</html>